<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>events.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">events.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    <span class='nodesc'>No description.</span>
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="http://closure-library.googlecode.com/git/closure/goog/demos/events.html">Demo</a></li>
            <li><a href="local_closure_goog_events_events.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/events/events.js">Git</a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">/goog/events/events.js</div>
    </div>
  </div>
<hr/>


   
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>



<h2>Enumerations</h2>






<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.dispatchEvent"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">dispatchEvent<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">e</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Dispatches an event (or event like object) and calls all listeners
listening for events of this type. The type of the event is decided by the
type property on the event object.

If any of the listeners returns false OR calls preventDefault then this
function will return false.  If one of the capture listeners calls
stopPropagation, then the bubble listeners won't fire.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The event target.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">e</span>
        : <span class="type">goog.events.EventLike</span>
        <div class="entryOverview">Event object.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            If anyone called preventDefault on the event object (or
    if any of the handlers returns false) this will also return false.
    If there are no handlers, or if all handlers return true, this returns
    true.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line786">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.expose"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">expose<span class="args">(<span class="arg">e</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
      </div>


     <div class="entryOverview">
       Provides a nice string showing the normalized event objects public members

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Event Object.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&nbsp;
            String of the public members of the normalized event object.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line656">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.getProxy&f"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getProxy&f<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line285">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.fireListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">fireListener<span class="args">(<span class="arg">listener</span>,&nbsp;<span class="arg">eventObject</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Fires a listener with a set of arguments


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">listener</span>
        : <span class="type"><a href="class_goog_events_Listener.html">goog.events.Listener</a></span>
        <div class="entryOverview">The listener object to call.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">eventObject</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">The event object to pass to the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Result of listener.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line746">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.fireListeners"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">fireListeners<span class="args">(<span class="arg">obj</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg">capture</span>,&nbsp;<span class="arg">eventObject</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Fires an object's listeners of a particular type and phase


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">obj</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Object whose listeners to call.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>
        <div class="entryOverview">Event type.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">capture</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Which event phase.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">eventObject</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Event object to be passed to listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            True if all listeners returned true else false.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line694">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.fireListeners_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">fireListeners_<span class="args">(<span class="arg">obj</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg">capture</span>,&nbsp;<span class="arg">eventObject</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Fires an object's listeners of a particular type and phase.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">obj</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Object whose listeners to call.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>
        <div class="entryOverview">Event type.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">capture</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Which event phase.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">eventObject</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Event object to be passed to listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            True if all listeners returned true else false.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line712">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.getListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getListener<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
        &#8658; <span class="type"><a href="interface_goog_events_ListenableKey.html">goog.events.ListenableKey</a></span>
      </div>


     <div class="entryOverview">
       Gets the goog.events.Listener for the event or null if no such listener is
in use.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The target from
    which to get listeners.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span>?</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>.&lt;<span class="type">EVENTOBJ</span>&gt;
        <div class="entryOverview">The type of the event.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName"></span>
        : <span class="type">function(EVENTOBJ</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">In DOM-compliant browsers, this determines
                           whether the listener is fired during the
                           capture or bubble phase of the event.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="interface_goog_events_ListenableKey.html">goog.events.ListenableKey</a></span>&nbsp;
            the found listener or null if not found.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line603">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.getListenerMap_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getListenerMap_<span class="args">(<span class="arg">src</span>)</span>
        </span>
        &#8658; <span class="type"><a href="class_goog_events_ListenerMap.html">goog.events.ListenerMap</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span>
        <div class="entryOverview">The source object.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="class_goog_events_ListenerMap.html">goog.events.ListenerMap</a></span>&nbsp;
            A listener map for the given
    source object, or null if none exists.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line954">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.getListeners"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getListeners<span class="args">(<span class="arg">obj</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg">capture</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="class_goog_events_Listener.html">goog.events.Listener</a></span>&gt;
      </div>


     <div class="entryOverview">
       Gets the listeners for a given object, type and capture phase.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">obj</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>
        <div class="entryOverview">Object to get listeners for.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>
        <div class="entryOverview">Event type.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">capture</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Capture phase?.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="class_goog_events_Listener.html">goog.events.Listener</a></span>&gt;&nbsp;
            Array of listener objects.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line570">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.getOnString_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getOnString_<span class="args">(<span class="arg">type</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
      </div>


     <div class="entryOverview">
       Returns a string with on prepended to the specified type. This is used for IE
which expects "on" to be prepended. This function caches the string in order
to avoid extra allocations in steady state.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">Event type.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&nbsp;
            The type string with 'on' prepended.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line677">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.getProxy"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getProxy<span class="args">()</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span>
      </div>


     <div class="entryOverview">
       Helper function for returning a proxy function.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span>&nbsp;
            A new or reused function object.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line282">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td class="deprecated">
    <a name="goog.events.getTotalListenerCount"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getTotalListenerCount<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       <span class="deprecatedMessage">This returns estimated count, now that Closure no longer
stores a central listener registry. We still return an estimation
to keep existing listener-related tests passing. In the near future,
this function will be removed.</span>
       Gets the total number of listeners currently in the system.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            Number of listeners.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line765">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.getUniqueId"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getUniqueId<span class="args">(<span class="arg">identifier</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
      </div>


     <div class="entryOverview">
       Creates a unique event id.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">identifier</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">The identifier.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&nbsp;
            A unique identifier.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line943">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.handleBrowserEvent_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">handleBrowserEvent_<span class="args">(<span class="arg">listener</span>,&nbsp;<span class="arg">opt_evt</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Handles an event and dispatches it to the correct listeners. This
function is a proxy for the real listener the user specified.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">listener</span>
        : <span class="type"><a href="class_goog_events_Listener.html">goog.events.Listener</a></span>
        <div class="entryOverview">The listener object.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_evt</span>
        : <span class="type">Event=</span>
        <div class="entryOverview">Optional event object that gets passed in via the
    native event handlers.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Result of the event handler.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line819">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.hasListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">hasListener<span class="args">(<span class="arg">obj</span>,&nbsp;<span class="arg">opt_type</span>,&nbsp;<span class="arg">opt_capture</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Returns whether an event target has any active listeners matching the
specified signature. If either the type or capture parameters are
unspecified, the function will match on the remaining criteria.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">obj</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">Target to get
    listeners for.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type">goog.events.EventId=</span>
        <div class="entryOverview">Event type.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_capture</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Whether to check for capture or bubble-phase
    listeners.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether an event target has one or more listeners matching
    the requested type and/or capture phase.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line640">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.isMarkedIeEvent_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">isMarkedIeEvent_<span class="args">(<span class="arg">e</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       This is used to check if an IE event has already been handled by the Closure
system so we do not do the Closure pass twice for a bubbling event.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type">Event</span>
        <div class="entryOverview">The IE browser event.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            True if the event object has been marked.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line924">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.listen"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">listen<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
        &#8658; <span class="type">goog.events.Key</span>
      </div>


     <div class="entryOverview">
       Adds an event listener for a specific event on a native event
target (such as a DOM element) or an object that has implemented
<code> goog.events.Listenable</code>. A listener can only be added once
to an object and if it is added again the key for the listener is
returned. Note that if the existing listener is a one-off listener
(registered via listenOnce), it will no longer be a one-off
listener after a call to listen().


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The node to listen
    to events on.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&gt;<span>&nbsp;|&nbsp;</span><span class="type">
       !goog.events.EventId</span>.&lt;<span class="type">EVENTOBJ</span>&gt;<span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>.&lt;<span class="type">EVENTOBJ</span>&gt;&gt;
        <div class="entryOverview">Event type or array of event types.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName"></span>
        : <span class="type">function(this:T, EVENTOBJ</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Whether to fire in capture phase (defaults to
    false).</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">T=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type">goog.events.Key</span>&nbsp;
            Unique key for the listener.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line180">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.listenOnce"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">listenOnce<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
        &#8658; <span class="type">goog.events.Key</span>
      </div>


     <div class="entryOverview">
       Adds an event listener for a specific event on a native event
target (such as a DOM element) or an object that has implemented
<code> goog.events.Listenable</code>. After the event has fired the event
listener is removed from the target.

If an existing listener already exists, listenOnce will do
nothing. In particular, if the listener was previously registered
via listen(), listenOnce() will not turn the listener into a
one-off listener. Similarly, if there is already an existing
one-off listener, listenOnce does not modify the listeners (it is
still a once listener).


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The node to listen
    to events on.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&gt;<span>&nbsp;|&nbsp;</span><span class="type">
       !goog.events.EventId</span>.&lt;<span class="type">EVENTOBJ</span>&gt;<span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>.&lt;<span class="type">EVENTOBJ</span>&gt;&gt;
        <div class="entryOverview">Event type or array of event types.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName"></span>
        : <span class="type">function(this:T, EVENTOBJ</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Fire in capture phase?.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">T=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type">goog.events.Key</span>&nbsp;
            Unique key for the listener.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line328">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.listenWithWrapper"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">listenWithWrapper<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">wrapper</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Adds an event listener with a specific event wrapper on a DOM Node or an
object that has implemented <code> goog.events.Listenable</code>. A listener can
only be added once to an object.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The target to
    listen to events on.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">wrapper</span>
        : <span class="type"><a href="interface_goog_events_EventWrapper.html">goog.events.EventWrapper</a></span>
        <div class="entryOverview">Event wrapper to use.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName"></span>
        : <span>?</span><span class="type">function(this:T, </span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Whether to fire in capture phase (defaults to
    false).</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">T=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line365">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.listen_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">listen_<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg">listener</span>,&nbsp;<span class="arg">callOnce</span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
        &#8658; <span class="type"><a href="interface_goog_events_ListenableKey.html">goog.events.ListenableKey</a></span>
      </div>


     <div class="entryOverview">
       Adds an event listener for a specific event on a native event
target. A listener can only be added once to an object and if it
is added again the key for the listener is returned.

Note that a one-off listener will not change an existing listener,
if any. On the other hand a normal listener will change existing
one-off listener to become a normal listener.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span>
        <div class="entryOverview">The node to listen to events on.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>
        <div class="entryOverview">Event type.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">listener</span>
        : <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span>
        <div class="entryOverview">Callback function.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">callOnce</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
        <div class="entryOverview">Whether the listener is a one-off
    listener or otherwise.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Whether to fire in capture phase (defaults to
    false).</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="interface_goog_events_ListenableKey.html">goog.events.ListenableKey</a></span>&nbsp;
            Unique key for the listener.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line222">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.events.markIeEvent_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">markIeEvent_<span class="args">(<span class="arg">e</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       This is used to mark the IE event object so we do not do the Closure pass
twice for a bubbling event.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">e</span>
        : <span class="type">Event</span>
        <div class="entryOverview">The IE browser event.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line885">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.protectBrowserEventEntryPoint"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">protectBrowserEventEntryPoint<span class="args">(<span class="arg">errorHandler</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Installs exception protection for the browser event entry point using the
given error handler.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">errorHandler</span>
        : <span class="type"><a href="class_goog_debug_ErrorHandler.html">goog.debug.ErrorHandler</a></span>
        <div class="entryOverview">Error handler with which to
    protect the entry point.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line802">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.getProxy&proxyCallbackFunction"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">getProxy&proxyCallbackFunction<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line283">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.removeAll"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">removeAll<span class="args">(<span class="arg">opt_obj</span>,&nbsp;<span class="arg">opt_type</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       Removes all listeners from an object. You can also optionally
remove listeners of a particular type.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">opt_obj</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Object to remove listeners from. Not
    specifying opt_obj is now DEPRECATED (it used to remove all
    registered listeners).</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span>!</span><span class="type">goog.events.EventId=</span>
        <div class="entryOverview">Type of event to remove.
    Default is all types.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            Number of listeners removed.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line511">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td class="deprecated">
    <a name="goog.events.removeAllNativeListeners"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">removeAllNativeListeners<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       <span class="deprecatedMessage">This doesn't do anything, now that Closure no longer
stores a central listener registry.</span>
       Removes all native listeners registered via goog.events. Native
listeners are listeners on native browser objects (such as DOM
elements). In particular, goog.events.Listenable and
goog.events.EventTarget listeners will NOT be removed.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            Number of listeners removed.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line556">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.unlisten"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">unlisten<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">type</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
        &#8658; <span>?</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Removes an event listener which was added with listen().


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The target to stop
    listening to events on.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">type</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>&gt;<span>&nbsp;|&nbsp;</span><span class="type">
       !goog.events.EventId</span>.&lt;<span class="type">EVENTOBJ</span>&gt;<span>&nbsp;|&nbsp;</span><span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span>!</span><span class="type"><a href="class_goog_events_EventId.html">goog.events.EventId</a></span>.&lt;<span class="type">EVENTOBJ</span>&gt;&gt;
        <div class="entryOverview">Event type or array of event types to unlisten to.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName"></span>
        : <span>?</span><span class="type">function(</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">In DOM-compliant browsers, this determines
    whether the listener is fired during the capture or bubble phase of the
    event.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>?</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            indicating whether the listener was there to remove.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line388">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.unlistenByKey"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">unlistenByKey<span class="args">(<span class="arg">key</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Removes an event listener which was added with listen() by the key
returned by listen().


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">key</span>
        : <span class="type">goog.events.Key</span>
        <div class="entryOverview">The key returned by listen() for this
    event listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            indicating whether the listener was there to remove.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line433">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.unlistenWithWrapper"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">unlistenWithWrapper<span class="args">(<span class="arg">src</span>,&nbsp;<span class="arg">wrapper</span>,&nbsp;<span class="arg"></span>,&nbsp;<span class="arg">opt_capt</span>,&nbsp;<span class="arg">opt_handler</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Removes an event listener which was added with listenWithWrapper().


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">src</span>
        : <span class="type">EventTarget</span><span>&nbsp;|&nbsp;</span><span class="type"><a href="interface_goog_events_Listenable.html">goog.events.Listenable</a></span>
        <div class="entryOverview">The target to stop
    listening to events on.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">wrapper</span>
        : <span class="type"><a href="interface_goog_events_EventWrapper.html">goog.events.EventWrapper</a></span>
        <div class="entryOverview">Event wrapper to use.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName"></span>
        : <span>?</span><span class="type">function(</span>)<span>:?</span><span>&nbsp;|&nbsp;</span><span>?</span><span class="type">{handleEvent:function(</span>)<span>:?</span>
        <div class="entryOverview"><span class='nodesc'>No description.</span></div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_capt</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">In DOM-compliant browsers, this determines
    whether the listener is fired during the capture or bubble phase of the
    event.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_handler</span>
        : <span class="type">Object=</span>
        <div class="entryOverview">Element in whose scope to call the listener.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line494">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.events.wrapListener"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.events.</span><span class="entryName">wrapListener<span class="args">(<span class="arg">listener</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">listener</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span>
        <div class="entryOverview">The listener function or an
    object that contains handleEvent method.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span>&nbsp;
            Either the original function or a function that
    calls obj.handleEvent. If the same listener is passed to this
    function more than once, the same function is guaranteed to be
    returned.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line980">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>






  <h2>Global Variables</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="function%13"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">function%13</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_events_events.js.source.html#line1003">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory events</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="" current="/goog/events/events.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
